[TypeSpec]: Fix Traffic Controller cadl #24082

markcowl · 2023-05-20T00:34:23Z

ARM API Information (Control Plane)

Changelog

Add a changelog entry for this PR by answering the following questions:

What's the purpose of the update?
- new service onboarding
- new API version
- update existing version for new feature
- update existing version to fix swagger quality issue in s360
- Other, please clarify
When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

I commit to follow the Breaking Change Policy of "no breaking changes"
I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and errors have all been fixed in this PR. How to fix?

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

Change to data plane APIs

Adding new properties

All removals

Otherwise your PR may be subject to ARM review requirements. Complete the following:

Check this box if any of the following apply to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
- Adding a new service
- Adding new API(s)
- Adding a new API version
  -[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Note that this doesn't apply if you are trying to merge a PR that was previously in the private repository.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

…r/azure-rest-api-specs into fix-service-net

openapi-workflow-bot · 2023-05-20T00:34:26Z

Hi, @markcowl Thanks for your PR. I am workflow bot for review process. Here are some small tips.

Please ensure to do self-check against checklists in first PR comment.

PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.

For specs comparison cross API versions, Use API Specs Comparison Report Generator

If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

openapi-pipeline-app · 2023-05-20T00:34:33Z

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]

There are no breaking changes.

compared swaggers (via Oad v0.10.4)]	new version	base version
TrafficController.json	2023-05-01-preview(f483c87)	2023-05-01-preview(main)

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

compared tags (via openapi-validator v2.1.2)	new version	base version
default	default(f483c87)	default(main)

The following errors/warnings exist before current PR submission:

Rule	Message
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L253
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L554
`❌` PutResponseSchemaDescription	Description of 200 response code of a PUT operation MUST include term 'update'. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L871
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L370
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L687
⚠️ ProvisioningStateSpecifiedForLRODelete	200 response schema in long running DELETE operation is missing ProvisioningState property. A LRO DELETE operations 200 response schema must have ProvisioningState specified. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1004
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1132
⚠️ SchemaDescriptionOrTitle	Schema should have a description or title. Location: Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json#L1247

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️️✔️ApiReadinessCheck succeeded [Detail] [Expand]

️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]

API Test is not triggered due to precheck failure. Check pipeline log for details.

️️✔️SwaggerAPIView succeeded [Detail] [Expand]

️️✔️CadlAPIView succeeded [Detail] [Expand]

️️✔️TypeSpecAPIView succeeded [Detail] [Expand]

️️✔️ModelValidation succeeded [Detail] [Expand]

Validation passes for ModelValidation.

️️✔️SemanticValidation succeeded [Detail] [Expand]

Validation passes for SemanticValidation.

️️✔️PoliCheck succeeded [Detail] [Expand]

Validation passed for PoliCheck.

️️✔️PrettierCheck succeeded [Detail] [Expand]

Validation passes for PrettierCheck.

️️✔️SpellCheck succeeded [Detail] [Expand]

Validation passes for SpellCheck.

️️✔️Lint(RPaaS) succeeded [Detail] [Expand]

Validation passes for Lint(RPaaS).

️️✔️CadlValidation succeeded [Detail] [Expand]

Validation passes for CadlValidation.

️️✔️TypeSpec Validation succeeded [Detail]

Rule	Message
`❌` InConsistentSwagger	"details":"The generated swagger file 2023-05-01-preview/TrafficController.json from typespec specification/servicenetworking/ServiceNetworking.Management is not the same as the '/mnt/vss/_work/1/azure-rest-api-specs/specification/servicenetworking/resource-manager/Microsoft.ServiceNetworking/preview/2023-05-01-preview/TrafficController.json' in PR, please make sure the swagger is consistent with the generated swagger. You can find the difference in the pipeline log."

️️✔️PR Summary succeeded [Detail] [Expand]

Validation passes for Summary.

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-20T00:34:34Z

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

Breaking Changes Tracking

️⚠️ azure-sdk-for-python-track2 warning [Detail]

⚠️Warning [Logs]Release - Generate from 58576fa. SDK Automation 14.0.0

command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
warn		specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml skipped due to azure-sdk-for-python-track2 not found in tspconfig.yaml
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh]  New minor version of npm available! 9.5.1 -> 9.6.7
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.6.7>
cmderr	[automation_generate.sh] npm notice Run `npm install -g npm@9.6.7` to update!
cmderr	[automation_generate.sh] npm notice

️✔️track2_azure-mgmt-servicenetworking [View full logs] [Release SDK Changes]
- azure-mgmt-servicenetworking-1.0.0b1.zip
- azure_mgmt_servicenetworking-1.0.0b1-py3-none-any.whl
```
info	[Changelog]
```

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

️✔️Succeeded [Logs]Release - Generate from 58576fa. SDK Automation 14.0.0

command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
warn		specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml skipped due to azure-sdk-for-go not found in tspconfig.yaml
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json

️✔️sdk/resourcemanager/servicenetworking/armservicenetworking [View full logs] [Release SDK Changes]

info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).

_{Posted by Swagger Pipeline | How to fix these errors?}

openapi-pipeline-app · 2023-05-20T00:34:34Z

Generated ApiView

Language	Package Name	ApiView Link
Go	sdk/resourcemanager/servicenetworking/armservicenetworking	https://apiview.dev/Assemblies/Review/c3d2355d83e94adc9595f59c25b58f2c

kazrael2119 · 2023-05-22T02:11:57Z

/azp run

azure-pipelines · 2023-05-22T02:12:09Z

Azure Pipelines successfully started running 2 pipeline(s).

kazrael2119 · 2023-05-22T05:43:10Z

@msyyc @tadelesh ,please help review sdk breaking changes , thanks

specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml

mikeharder

arm-types-dir should be removed from tspconfig.yaml, since the default value should now work in the repo. Otherwise LGTM.

mikeharder and others added 9 commits May 19, 2023 01:21

[TypeSpec CI] Add Microsoft.ServiceNetworking

52d0822

Move files to align with repo conventions

3e11c1b

Restore README files

42eeafb

Add arm-types-dir

56caac1

Update $ref paths

de72737

Merge branch 'typespec-ci-traffic-controller' of github.com:mikeharde…

f6c23ee

…r/azure-rest-api-specs into fix-service-net

Updating ServiceNetworking

f4d6e2e

Updating for pattern and optionality

cae63b4

Renaming directory properly this time

707a59c

openapi-assignment-bot bot assigned kazrael2119 May 20, 2023

AzureRestAPISpecReview added the resource-manager label May 20, 2023

azure-sdk mentioned this pull request May 20, 2023

[AutoPR sdk/resourcemanager/servicenetworking/armservicenetworking] [TypeSpec]: Fix Traffic Controller cadl azure-sdk/azure-sdk-for-go#5784

Closed

openapi-pipeline-app bot added the CI-BreakingChange-Go label May 20, 2023

Fix pipeline directory

3cb56e8

azure-sdk mentioned this pull request May 20, 2023

[AutoPR track2_azure-mgmt-servicenetworking] [TypeSpec]: Fix Traffic Controller cadl azure-sdk/azure-sdk-for-python#3623

Closed

markcowl added 2 commits May 19, 2023 17:45

renaming

73e488d

And renaming

431154d

openapi-pipeline-app bot added the CI-BreakingChange-Python-Track2 label May 20, 2023

tadelesh added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label May 23, 2023

msyyc added the Approved-SdkBreakingChange-Python label May 23, 2023

mikeharder mentioned this pull request May 23, 2023

Align Microsoft.ServiceNetworking with repo conventions #24060

Closed

mikeharder requested changes May 23, 2023

View reviewed changes

specification/servicenetworking/ServiceNetworking.Management/tspconfig.yaml Outdated Show resolved Hide resolved

mikeharder requested changes May 23, 2023

View reviewed changes

markcowl added 2 commits May 24, 2023 13:09

Merge branch 'main' into fix-service-net

4b047f8

Remove unneeded settings

f483c87

markcowl requested a review from mikeharder May 24, 2023 21:12

mikeharder approved these changes May 25, 2023

View reviewed changes

mikeharder merged commit 58576fa into Azure:main May 25, 2023

This was referenced May 25, 2023

[ReleasePR sdk/resourcemanager/servicenetworking/armservicenetworking] AGC Version 2023-11-01 Azure/azure-sdk-for-go#19764

Closed

[ReleasePR track2_azure-mgmt-servicenetworking] AGC Version 2023-11-01 Azure/azure-sdk-for-python#28131

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[TypeSpec]: Fix Traffic Controller cadl #24082

[TypeSpec]: Fix Traffic Controller cadl #24082

markcowl commented May 20, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-workflow-bot bot commented May 20, 2023

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading

Breaking Changes Tracking

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading

kazrael2119 commented May 22, 2023

azure-pipelines bot commented May 22, 2023

kazrael2119 commented May 22, 2023

mikeharder left a comment

[TypeSpec]: Fix Traffic Controller cadl #24082

[TypeSpec]: Fix Traffic Controller cadl #24082

Conversation

markcowl commented May 20, 2023 • edited by openapi-workflow-bot bot Loading

ARM API Information (Control Plane)

Changelog

Contribution checklist (MS Employees Only):

ARM API Review Checklist

Breaking Change Review Checklist

openapi-workflow-bot bot commented May 20, 2023

openapi-pipeline-app bot commented May 20, 2023 • edited Loading

Swagger Validation Report

openapi-pipeline-app bot commented May 20, 2023 • edited Loading

Swagger Generation Artifacts

Breaking Changes Tracking

openapi-pipeline-app bot commented May 20, 2023 • edited Loading

Generated ApiView

kazrael2119 commented May 22, 2023

azure-pipelines bot commented May 22, 2023

kazrael2119 commented May 22, 2023

mikeharder left a comment

Choose a reason for hiding this comment

markcowl commented May 20, 2023 •

edited by openapi-workflow-bot bot

Loading

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading

openapi-pipeline-app bot commented May 20, 2023 •

edited

Loading